home *** CD-ROM | disk | FTP | other *** search
/ Apple Developer Connection 1998 Fall: Game Toolkit / Disc.iso / SDKs / QuickTime Mac / AIncludes / QD3DExtension.a < prev    next >
Encoding:
Text File  |  1998-04-09  |  8.7 KB  |  317 lines  |  [TEXT/MPS ]
  1. ;
  2. ;    File:        QD3DExtension.a
  3. ;
  4. ;    Contains:    QuickDraw 3D Plug-in Architecture     Interface File.                                
  5. ;
  6. ;    Version:    Technology:    Quickdraw 3D 1.5.4
  7. ;                Release:    QuickTime 3.0
  8. ;
  9. ;    Copyright:    © 1995-1998 by Apple Computer, Inc., all rights reserved.
  10. ;
  11. ;    Bugs?:        Please include the the file and version information (from above) with
  12. ;                the problem description.  Developers belonging to one of the Apple
  13. ;                developer programs can submit bug reports to:
  14. ;
  15. ;                    devsupport@apple.com
  16. ;
  17. ;
  18.     IF &TYPE('__QD3DEXTENSION__') = 'UNDEFINED' THEN
  19. __QD3DEXTENSION__ SET 1
  20.  
  21.     IF &TYPE('__QD3D__') = 'UNDEFINED' THEN
  22.     include 'QD3D.a'
  23.     ENDIF
  24.     IF &TYPE('__QD3DERRORS__') = 'UNDEFINED' THEN
  25.     include 'QD3DErrors.a'
  26.     ENDIF
  27.  
  28. ; ******************************************************************************
  29. ; **                                                                             **
  30. ; **                                Constants                                      **
  31. ; **                                                                             **
  32. ; ****************************************************************************
  33.  
  34.     IF TARGET_OS_MAC THEN
  35.  
  36. kQ3XExtensionMacCreatorType        EQU        'Q3XT'
  37. kQ3XExtensionMacFileType        EQU        'shlb'
  38.     ENDIF    ; TARGET_OS_MAC
  39.  
  40. ; ******************************************************************************
  41. ; **                                                                             **
  42. ; **                                Object Method types                              **
  43. ; **                                                                             **
  44. ; ****************************************************************************
  45.  
  46.  
  47. kQ3XMethodTypeObjectClassVersion EQU    'vrsn'
  48. ; typedef unsigned long                 TQ3XObjectClassVersion
  49.  
  50.  
  51. kQ3XMethodTypeObjectClassRegister EQU    'rgst'
  52.  
  53. kQ3XMethodTypeObjectClassReplace EQU    'rgrp'
  54.  
  55. kQ3XMethodTypeObjectClassUnregister EQU    'unrg'
  56.  
  57. kQ3XMethodTypeObjectNew            EQU        'newo'
  58.  
  59. kQ3XMethodTypeObjectDelete        EQU        'dlte'
  60.  
  61. kQ3XMethodTypeObjectDuplicate    EQU        'dupl'
  62. ; ******************************************************************************
  63. ; **                                                                             **
  64. ; **                            Object Hierarchy Registration                      **
  65. ; **                                                                             **
  66. ; ****************************************************************************
  67.  
  68. ; 
  69. ; *    Q3XObjectHierarchy_RegisterClass
  70. ; *    
  71. ; *    Register an object class in the QuickDraw 3D hierarchy.
  72. ; *    
  73. ; *    parentType            - an existing type in the hierarchy, or 0 to subclass
  74. ; *                            TQ3Object
  75. ; *    objectType            - the new object class type, used in the binary 
  76. ; *                        metafile.  This is assigned at run time and returned
  77. ; *                          to you.
  78. ; *    objectName            - the new object name, used in the text metafile
  79. ; *    metaHandler            - a TQ3XMetaHandler (may be NULL for some classes) 
  80. ; *                          which returns non-virtual methods
  81. ; *    virtualMetaHandler    - a TQ3XMetaHandler (may be NULL as well) which returns
  82. ; *                            virtual methods a child would inherit
  83. ; *    methodsSize            - the size of the class data needed (see 
  84. ; *                            GetClassPrivate calls below)
  85. ; *    instanceSize        - the size of the object instance data needed (see 
  86. ; *                            GetPrivate calls below)
  87. ; 
  88.  
  89. ;
  90. ; extern TQ3XObjectClass Q3XObjectHierarchy_RegisterClass(TQ3ObjectType parentType, TQ3ObjectType *objectType, char *objectName, TQ3XMetaHandler metaHandler, TQ3XMetaHandler virtualMetaHandler, unsigned long methodsSize, unsigned long instanceSize)
  91. ;
  92.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  93.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_RegisterClass
  94.     ENDIF
  95.  
  96. ; 
  97. ; *    Q3XObjectHierarchy_UnregisterClass
  98. ; *    
  99. ; *    Returns kQ3Failure if the objectClass still has objects 
  100. ; * around; the class remains registered.
  101. ; 
  102.  
  103. ;
  104. ; extern TQ3Status Q3XObjectHierarchy_UnregisterClass(TQ3XObjectClass objectClass)
  105. ;
  106.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  107.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_UnregisterClass
  108.     ENDIF
  109.  
  110. ; 
  111. ; *    Q3XObjectHierarchy_GetMethod
  112. ; *    
  113. ; *    For use in TQ3XObjectClassRegisterMethod call
  114. ; 
  115.  
  116. ;
  117. ; extern TQ3XFunctionPointer Q3XObjectClass_GetMethod(TQ3XObjectClass objectClass, TQ3XMethodType methodType)
  118. ;
  119.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  120.         IMPORT_CFM_FUNCTION Q3XObjectClass_GetMethod
  121.     ENDIF
  122.  
  123. ; 
  124. ; *    Q3XObjectHierarchy_NewObject
  125. ; *    
  126. ; *    To create a new object. Parameters is passed into the 
  127. ; *    TQ3XObjectNewMethod as the "parameters" parameter.
  128. ; 
  129.  
  130. ;
  131. ; extern TQ3Object Q3XObjectHierarchy_NewObject(TQ3XObjectClass objectClass, void *parameters)
  132. ;
  133.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  134.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_NewObject
  135.     ENDIF
  136.  
  137. ; 
  138. ; *    Q3XObjectClass_GetLeafType
  139. ; *    
  140. ; *    Return the leaf type of a class.
  141. ; 
  142.  
  143. ;
  144. ; extern TQ3ObjectType Q3XObjectClass_GetLeafType(TQ3XObjectClass objectClass)
  145. ;
  146.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  147.         IMPORT_CFM_FUNCTION Q3XObjectClass_GetLeafType
  148.     ENDIF
  149.  
  150. ; 
  151. ; *    Q3XObjectClass_GetVersion
  152. ; *    This routine obtains the the version of a class, referenced by an
  153. ; *    object class type.  Functions for getting the type are in QD3D.h,
  154. ; *    if you have the class name.
  155. ; 
  156.  
  157. ;
  158. ; extern TQ3Status Q3XObjectHierarchy_GetClassVersion(TQ3ObjectType objectClassType, TQ3XObjectClassVersion *version)
  159. ;
  160.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  161.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_GetClassVersion
  162.     ENDIF
  163.  
  164. ; 
  165. ; *    Q3XObjectClass_GetType 
  166. ; *
  167. ; *    This can be used to get the type, given a reference 
  168. ; *    to a class.  This is most useful in the instance where you register a 
  169. ; *    an element/attribute and need to get the type.  When you register an
  170. ; *    element, QD3D will take the type you pass in and modify it (to avoid
  171. ; *    namespace clashes).  Many object system calls require an object type
  172. ; *    so this API call allows you to get the type from the class referernce
  173. ; *    that you will ordinarily store when you register the class.
  174. ; 
  175.  
  176. ;
  177. ; extern TQ3Status Q3XObjectClass_GetType(TQ3XObjectClass objectClass, TQ3ObjectType *theType)
  178. ;
  179.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  180.         IMPORT_CFM_FUNCTION Q3XObjectClass_GetType
  181.     ENDIF
  182.  
  183.  
  184. ;
  185. ; extern TQ3XObjectClass Q3XObjectHierarchy_FindClassByType(TQ3ObjectType theType)
  186. ;
  187.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  188.         IMPORT_CFM_FUNCTION Q3XObjectHierarchy_FindClassByType
  189.     ENDIF
  190.  
  191.  
  192.  
  193. ; 
  194. ; *    Q3XObjectClass_GetPrivate
  195. ; *    
  196. ; *    Return a pointer to private instance data, a block of instanceSize bytes, 
  197. ; *    from the Q3XObjectHierarchy_RegisterClass call.
  198. ; *    
  199. ; *    If instanceSize was zero, NULL is always returned.
  200. ; 
  201.  
  202. ;
  203. ; extern void *Q3XObjectClass_GetPrivate(TQ3XObjectClass objectClass, TQ3Object targetObject)
  204. ;
  205.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  206.         IMPORT_CFM_FUNCTION Q3XObjectClass_GetPrivate
  207.     ENDIF
  208.  
  209. ; 
  210. ; * Return the "TQ3XObjectClass" of an object
  211. ; 
  212.  
  213. ;
  214. ; extern TQ3XObjectClass Q3XObject_GetClass(TQ3Object object)
  215. ;
  216.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  217.         IMPORT_CFM_FUNCTION Q3XObject_GetClass
  218.     ENDIF
  219.  
  220.  
  221.  
  222. ; ******************************************************************************
  223. ; **                                                                             **
  224. ; **                    Shared Library Registration Entry Point                      **
  225. ; **                                                                             **
  226. ; ****************************************************************************
  227.  
  228. TQ3XSharedLibraryInfo    RECORD 0
  229. registerFunction         ds.l    1                ; offset: $0 (0)
  230. sharedLibrary             ds.l    1                ; offset: $4 (4)
  231. sizeof                     EQU *                    ; size:   $8 (8)
  232.                         ENDR
  233. ;
  234. ; extern TQ3Status Q3XSharedLibrary_Register(TQ3XSharedLibraryInfo *sharedLibraryInfo)
  235. ;
  236.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  237.         IMPORT_CFM_FUNCTION Q3XSharedLibrary_Register
  238.     ENDIF
  239.  
  240. ;
  241. ; extern TQ3Status Q3XSharedLibrary_Unregister(unsigned long sharedLibrary)
  242. ;
  243.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  244.         IMPORT_CFM_FUNCTION Q3XSharedLibrary_Unregister
  245.     ENDIF
  246.  
  247.  
  248. ; ******************************************************************************
  249. ; **                                                                             **
  250. ; **                                Posting Errors                                  **
  251. ; **                                                                             **
  252. ; **            You may only call these functions from within an extension         **
  253. ; **                                                                             **
  254. ; ****************************************************************************
  255.  
  256. ; 
  257. ; *    Q3XError_Post
  258. ; *    
  259. ; *    Post a QuickDraw 3D Error from an extension.
  260. ; 
  261.  
  262. ;
  263. ; extern void Q3XError_Post(TQ3Error error)
  264. ;
  265.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  266.         IMPORT_CFM_FUNCTION Q3XError_Post
  267.     ENDIF
  268.  
  269. ; 
  270. ; *    Q3XWarning_Post
  271. ; *    
  272. ; *    Post a QuickDraw 3D Warning, from an extension.  Note the warning code you
  273. ; *    pass into this routine must already be defined in the table above.
  274. ; 
  275.  
  276. ;
  277. ; extern void Q3XWarning_Post(TQ3Warning warning)
  278. ;
  279.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  280.         IMPORT_CFM_FUNCTION Q3XWarning_Post
  281.     ENDIF
  282.  
  283. ; 
  284. ; *    Q3XNotice_Post
  285. ; *    
  286. ; *    Post a QuickDraw 3D Notice, from an extension.  Note the notice code you
  287. ; *    pass into this routine must already be defined in the table above.
  288. ; 
  289.  
  290. ;
  291. ; extern void Q3XNotice_Post(TQ3Notice notice)
  292. ;
  293.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  294.         IMPORT_CFM_FUNCTION Q3XNotice_Post
  295.     ENDIF
  296.  
  297.  
  298.     IF TARGET_OS_MAC THEN
  299. ; 
  300. ; *    Q3XMacintoshError_Post
  301. ; *    
  302. ; *    Post the QuickDraw 3D Error, kQ3ErrorMacintoshError, and the Macintosh
  303. ; *    OSErr macOSErr. (Retrieved with Q3MacintoshError_Get)
  304. ; 
  305.  
  306. ;
  307. ; extern void Q3XMacintoshError_Post(OSErr macOSErr)
  308. ;
  309.     IF TARGET_OS_MAC ** TARGET_RT_MAC_CFM THEN
  310.         IMPORT_CFM_FUNCTION Q3XMacintoshError_Post
  311.     ENDIF
  312.  
  313.     ENDIF    ; TARGET_OS_MAC
  314.  
  315.     ENDIF ; __QD3DEXTENSION__ 
  316.  
  317.